GARANT System . Technical description.

Supply Options 

GARANT is supplied in the following options: 

a) local installation 
c) installation network file server, multiple-user
c) installation network client server, multiple-user

See below for detailed description of the technical aspects of work of the above supply options. 

Supported Platforms 

The local option, the client part of the network option work under following Windows: XP, 2003, Vista, 2008, 7, 8, 2012, 8.1, 10.. They do not work under operating systems other than Windows. 

The network file server option may be installed on any file servers, including those working under the following operating systems: 
•	Windows XP, 2003, Vista, 2008, 7, 8, 2012, 8.1, 10;
•	Novell Netware;
•	Linux;
•	Solaris;
•	FreeBSD;
•	other 

Note 1: Installation of the network file server option must be launched on a Windows XP and over  and operated computer regardless of the operating system on the server. I.e. installation on the server operated by Novell or Linux must be launched from the workstation. 
Note 2: If you want the in-built online services work correctly, it is necessary that Internet Explorer 10.0 or higher is installed on the computer (or actual version of Mozilla Firefox, Google Chrome, или Opera). 
Note 3: The shell installation wizard needs the following video regime: at least 256 colours and 1024x768 resolutions. 
Note 4: You need TCP/IP protocol for client-server version.
Note 4: For correct working of different online services you need access to our servers *.garant.ru. 
Technical Requirements 
The minimum configuration (for the most small kit) may include:

Client computers of the network option, local option, working disk 
Celeron 500 MHz, 128 MB RAM

Server of client-server version:
Pentium3-800Мгц, 512 Мб ОЗУ 

Local Option 
Short Description 

The local option is intended for installation and launching on one Windows computer. 

Particulars of Installation, Updating and Functioning 

1.	Launching the local option is only possible on the computer where it was installed. 
2.	Installation wizard of the local option requires administrator access on the computer. 
3.	The program data installation wizard (%Garant%\datasetup.exe) is intended to update and install the databank. See detailed description of this program in the in-built help file (%Garant%\Help\F1DataTools.chm). No additional rights are required to launch them other than the write access to the folder %Garant% (and its subfolders). 
4.	To install, launch SetupF1.exe from GARANT folder on the distribution disk and follow instructions. 
5.	At the first launch of the local option, the label to launch the program is created automatically on the desktop, the user is registered automatically in the system (with ADMINISTRATOR login and ADMINISTRATOR password) and the settings of Garant 5.x version found on this computer are automatically converted. The first launch will set automatically the parameter Automatic System Entry (it may be changed using the File menu item in the shell). Therefore, in subsequent launches of the system, the user will not have to enter his login and password (if only he disables this parameter). 
6.	Several Garant users may be registered on the computer with installed local option (to permit each user with access to this computer to be able to work with own settings in Garant system). To register a new user, uncheck the item Automatic System Entry in the settings, close the system, restart it and choose the New User item in the dialogue box Garant System Entry. 
7.	The settings of the local option are stored in the folder %Application Data%\Garant-Local\Settings. 
8.	The local option of GARANT addresses the following sections of the system registry: 

a)	HKEY_CURRENT_USER\Software\Garant.F1 and 
b)	HKEY_CURRENT_USER\Software\Garant.F1-Launcher (created at the first launch of the shell) 

Network File Server Option, multiple-user  

Short Description 

The network file server option is a set of program files and data files located on the file resource available over the network. Starting the file server option is actually starting the client shell on workstations. Separate server part is not available. This implies opportunities to install the file server option on any servers regardless of the operating system, as well as opportunities to install and update the software shells and the data from any Windows workstation. 
Particulars of Installation, Updating and Functioning 

1.	Installation of both the shell and the databank of the file server option may be arranged from any Windows workstation with the write access to the resource allocated for Garant system. 
2.	Shell installation wizard requires administrator access to the computer where it is launched. 
3.	The program data installation wizard (%Garant%\datasetup.exe) is intended to update and install the databank. See detailed description of this program in the in-built help file (%Garant%\Help\DataTools.chm). No additional rights are required to launch them other than the write access to the folder %Garant% (and its subfolders). 
4.	To install, launch SetupF1.exe from GARANT folder on the distribution disk and following instructions. 
5.	The clients for their work need the read access to the resource with installed Garant system. 
6.	Procedure of the first launch of the network file sever option is simplified to the maximum extent to permit the users to undergo it independently. Any additional rights for the user computer and, therefore, administrator involvement is not necessary. 
7.	Starting GARANT on the workstations is actually starting garant.exe program from the folder %Garant% available over the network. The label to launch GARANT is created automatically on the client computer desktop at the first launch. It is also recommended to choose the folder to store user settings at the first launch (%Application Data%\Garant-NET by default). After choosing the folder, the settings are copied, the user is registered automatically in the system (with ADMINISTRATOR login and ADMINISTRATOR password) and the settings of version 5.x found on this computer are automatically converted. The first launch will automatically set the Automatic System Entry parameter (it can be changed using the File menu item in the shell). Therefore, the user will not have to enter his login and password at subsequent system launches (if only he changes this parameter). 
8.	Several Garant users may be registered on each workstation (to permit each user with access to this computer to work with own settings in Garant system). To register a new user, uncheck item Automatic System Entry in the settings, close the system, restart it and choose item New User in the dialogue box Garant System Entry. 
9.	See detailed description of Garant shell in the in-built help file %Garant%\Help\F1Shell.chm. 
10.	The network file server options addresses the following sections of the system registry: 

a)	HKEY_CURRENT_USER\Software\Garant.F1 and 
b)	HKEY_CURRENT_USER\Software\Garant.F1-Launcher (created at workstations at the first shell launch) 

Network Client-Server Option, multiple-user  

Short Description 

The network client server option of Garant. GARANT is built using a client server architecture implying a separation into two program parts: the server and the client one. 

The server is a special program working on a dedicated powerful computer. The term “server” is used for both the name of the program and the name of the computer. The context usually shows what kind of server is implied – the software or the hardware. 

The client (client part) is the user application launched on workstations, i.e. user personal computers. The client part is actually the “face” of the system. It is the client part that is usually associated with the client server application with the user. Thus, GARANT program shell is the client part of the composite system. 

During their work, program shells launched by users on their computers turn to the system server for data. The sever retrieves the documents from the database, processes them appropriately and hands over to the program shell where the received data are displayed in the user interface. Many resource-consuming operations, such as, for example, document search, are also fulfilled on the server. 

Such separation pursues several goals, with two of them emphasised especially. First: system server fulfils the most labour-consuming part of the job permitting to reduce the load on the user personal computers, thus reducing significantly technical requirements to the workstations. The second advantage of the client server architecture is a significant reduction of the network traffic. The point is that the transfer of the request from the shell to the server and getting response creates a significantly lower load for the local network as compared to the case when each of the user shells contacts the system databank independently. 

Particulars of Installation, Updating and Functioning 

1.	The server part of the network option of GARANT (hereinafter, the server) is installed only on computers operated by Windows XP and higher (XP, 2003, 2008, Vista, 7, 8, 2012, 8.1, 10). 
2.	Installation of GARANT server shell must be launched only on the server (computer where GARANT server part will work and the data is stored). Installation wizard may be launched on the server through a terminal client on a workstation.
3.	To install and launch the GARANT server, you need administrator access on the server (computer). No computer reloading is necessary. 
4.	To install, start F1Setup.exe from GARANT folder on the distribution disk #1 and follow instructions (also see document “Step-by-step install-update (client-server)_.doc”). One of the steps of the installation wizard will ask you to enter the server (computer) ip-address and the port number where the clients will access the server.  Installation wizard will offer port 5051 by default, which is usually free. You can view the list of connections as follows: enter netstat –a in command line (if the result does not fit the screen, enter netstat –a ½ more – the result will be displayed in screens, with the following one after pressing the spacebar). 
5.	Installation wizard page requesting mail server parameters may be used to enter the outgoing mail server information to use it to send forgotten GARANT passwords to users. The mail will be sent to the e-mail address indicated at user registration (if entered). The outgoing mail server parameters may be omitted, in which case the passwords cannot be sent. 
6.	In the end, installation wizard of the network option will launch GARANT server (as a service). By default, the service is installed to be launched automatically at system start-up. If the server service is not started, check the rights to fulfil the operation (since the service is launched under system account, it is necessary to grant full access rights to %GARANT%\ folder to the “SYSTEM” or “ALL” security group on the server). Garant server service is controlled (stopped or started) using the server control panel (see its description in the in-built help file %Garant%\help\F1serverMng.chm), as well as using the section Services of the Windows control panel. Garant server needs about 2 minutes to stop – time necessary for correct automatic termination of work of all clients. 
7.	Installation and data updating procedure of the client server option may be launched both on the server and any of the workstations. Administrator access is not required for it. To launch a remote data update, one needs the read access to %GARANT%\ folder from the workstation. Ordinary users must not have access to this folder to prevent launching the data update (and damaging it). The client server option permits to update information without disconnecting the users working on the system. The following program is intended for databank update and installation: data installation (update) wizard (%Garant%\datasetup.exe). See the in-built help file for detailed description of these programs (%Garant%\Help\DataTools.chm). 
8.	To launch the client shell, you do not need access to the server folder where the server part of GARANT is installed. The folder with the client part (installation wizard of the network option will request the rout to this folder separately – %Program Files%\GarantClient\ by default) requires the read access. The client part may be installed on any file resource available to users, not necessarily the same machine where F1 server is installed (in particular, the client folder may (but not have to) be copied to the workstation and used to launch the shell from it). 
9.	Launching the client shall of the network option of GARANT is actually launching the program garant.exe from the client folder. Any installation on user computers is not necessary. At the first launch, the label to launch GARANT is created automatically on the desktop of the user computer. When working with the client part of GARANT, the register is addressed by adding an entry in line HKEY_CURRENT_USER\Software – this section may be accessed by all users (no need to reload or apply to administrator). See detailed description of Garant  shell in the in-built help file - %Garant%\Apps\F1Shell.chm. 
10.	User authorisation is necessary for the work of many important functions of GARANT. Registration procedure is simplified to the maximum extent to permit the users undergo it independently. At the first launch of the network option, a dialogue box of registration of new user appears on the client computer. It is necessary to enter login, password, user name and his e-mail (optional). For further registration of new users, it is necessary to uncheck item Automatic System Entry in the settings, close the system, restart it and choose item New User in the dialogue box Garant System Entry. 

But  it`s also possible to use automatic registration mode in GARANT. If this function was activated the user will not receive any additional registration windows (including the first start) or windows with login/password fields, and it can immediately begin to work with the system. To enable the mode of automatic registration of users (by default it is not enabled), it is necessary in garant.ini file of the client part (GARANT-Client folder by default)  in the section "[Default]" uncomment (remove the ";") the line 
«;CommandLine=-F1ShellLogin "%USERNAME%" $(CommandLineParams)»,
and also comment out (add the ";" in the beginning of the line) the line
«;CommandLine=$(CommandLineParams)». 
 As a result at the first start of the program there will be an automatic registration in GARANT system of the user with the login coinciding with login of this user in Windows (equal to a variable Windows %USERNAME %), field ФИО also equal to a variable Windows %USERNAME %, the empty password and an empty e-mail. At the subsequent starts of the GARANT the window with “login” and “password” fields will not be outputted. If the part of users need to launch GARANT under account with login different from login to Windows, then they can do it pressing SHIFT key during start of the program. 

11.	All user GARANT settings are stored on the server in the folder %Garant%\Settings. 
12.	 You can run “User`s Administrator” utility to administrate garant`s users profile (add or delete users, edit profiles, change password...). To launch it, you need to enter the system under administrator profile. Please run garant.exe with f1admin parameter (login: ADMIN, password: ADMIN). For example: %GARANT%\garant.exe f1admin

13.	Client requests are sent to the server to the port indicated at server installation (5051 by default). Therefore, if the server has Firewall protection, this port should be enabled in it (5051 by default) for incoming connections. The server responds to the workstations to the ports in the 3600 to 3609 range. Therefore, if the workstation has Firewall protection, this range (3600 to 3609) must be enabled for incoming connections. Some Firewalls (for example, the one in SP2 of Windows XP) permit incoming connections from a certain application to any port. In this case, there is no need to open the whole range. 
14.	The network client server option addresses the following sections of the system register: 

a.	HKEY_CURRENT_USER\Software\Garant.F1 and 
b.	HKEY_CURRENT_USER\Software\Garant.F1-Launcher (created at workstations at the first launch of the client shell)